# Planner Configuration
Defines Microsoft Planner boards with buckets and tasks for project and task management.
Referenced by: Office365GroupCfg, DocLibCfg.PlannerSet, SharepointCfg.PlannerCfgs.
# Overview
PlannerCfg defines a Planner board with buckets, tasks, and categories. Planner provides task management and project tracking within Microsoft 365 Groups and Teams.
Child configurations:
TaskCfg (list)— individual tasks with assignments and due dates
# Applied when
Planner boards are created when:
- The parent
Office365GroupCfgis provisioned and references this configuration - OR a
DocLibCfgis provisioned and references this configuration viaPlannerSet - SharePoint Online only — Planner boards are not supported on SharePoint 2016 or on-premises
- Applied after the parent group/library is created; the Planner board is created within the Microsoft 365 Group or associated with the library
- All buckets and tasks specified in
TaskCfg (list)are created as part of board initialization - The
SiteCollectionUrl(if provided) is used for load balancing when multiple Planner instances exist
# Core settings
# Name
Type: string | Default: — | Required: Yes
Unique name. Referenced from Office365GroupCfg or DocLibCfg.PlannerSet. Leading and trailing whitespace is automatically trimmed.
# Title
Type: string | Default: — | Required: No
Conditional default: Planner board title. If left empty, uses the default title configured in matter settings. If provided, overrides the default configured title.
# SiteCollectionUrl
Type: string | Default: — | Required: No
Load balancing: Site collection URL associated with the Planner. Supports multiple URLs separated by semicolons for round-robin load distribution (e.g., "https://tenant.sharepoint.com/sites/planner1;https://tenant.sharepoint.com/sites/planner2"). The system selects from these URLs in round-robin fashion.
# Structure
# Buckets
Type: string (list) | Default: — | Required: No
Array of bucket names to create (e.g., ["To Do", "In Progress", "Done"]).
# Tasks
Type: TaskCfg (list) | Default: — | Required: No
Array of task definitions.
# Categories
Up to 6 custom category labels can be defined. Each category can be applied to tasks via the corresponding TaskCfg.Category1 through TaskCfg.Category6 boolean flags.
# Category1
Type: string | Default: — | Required: No
First custom category name.
# Category2
Type: string | Default: — | Required: No
Second custom category name.
# Category3
Type: string | Default: — | Required: No
Third custom category name.
# Category4
Type: string | Default: — | Required: No
Fourth custom category name.
# Category5
Type: string | Default: — | Required: No
Fifth custom category name.
# Category6
Type: string | Default: — | Required: No
Sixth custom category name.
# Integration
# AddToChannelTab
Type: bool | Default: true | Required: No
Add Planner board as a tab in the Teams channel. When true, the Planner board is automatically added as a tab to team channels. When false, the Planner board is created but not added to channel tabs (can be added manually later).
# Related
- Task Configuration — individual tasks
- Office 365 Group Configuration — parent team
- Team Channel Configuration — Planner tab in channels